home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / CBV10B.ZIP / DCSCBV.DOC < prev    next >
Encoding:
Text File  |  1996-02-10  |  17.1 KB  |  422 lines
  1. DCSCBV v1.0ß, (c) 1996, Data Communication Systems
  2.  
  3. INTRODUCTION
  4. ============
  5.  
  6. DCSCBV is a Call Back Verifier for Maximus-CBCS v3.00.  This
  7. program was written with Borland Pascal v7.0.  Because this is a
  8. Beta Release, the documentation is very limited.  Every important
  9. aspect for installation has tried to have been covered but no
  10. guarantees will be made.  
  11.  
  12. If you have any problems, comments or suggestions, please feel
  13. free to contact Data Communication Systems at the address listed
  14. at the end of this documentation.  All suggestions will be taken
  15. into consideration for future releases of this software.
  16.  
  17.  
  18. LIMITATIONS AND REQUIREMENTS
  19. ============================
  20.  
  21. In order to use this software, you must meet the following
  22. requirements.
  23.  
  24. 1.             You must be running Maximus v3.x BBS software.  It
  25.                has been tested on both v3.00 and v3.01, but will
  26.                not run on any version below v3.00.
  27.  
  28. 2.             You cannot allow your users to enter or modify
  29.                information in the Data Phone field of the user
  30.                database.  This is where DCSCBV stores the
  31.                telephone numbers that has been dialed.
  32.  
  33.  
  34. QUICK INSTALLATION
  35. ==================
  36.  
  37. 1.             Create a directory (suggested \MAX\DCSCBV\) and
  38.                unzip the distribution archive into that
  39.                directory.
  40.  
  41. 2.             Unzip the archive SAMPLES.ZIP (contained in the
  42.                original archive) into the same directory.
  43.  
  44. 3.             Using a standard ASCII text editor, edit
  45.                DCSCBV.CFG and uncomment and modify the LOCAL_AREA
  46.                token to contain the three digit number of your
  47.                local calling area.
  48.  
  49. 4.             Using a standard ASCII text editor, create a file
  50.                named TRNSLATE.CFG containing a list of
  51.                translation strings for each prefix in your local
  52.                calling area.  For more information, see the
  53.                section on Translation Strings.
  54.  
  55. 5.             Modify your MENUS.CTL file to contain the
  56.                following line.
  57.  
  58.                Display_File  DCSCBV\DCSCBV  Demoted  "Register"
  59.  
  60. 6.             Run SILT.EXE and test your Call Back Verifier.
  61.  
  62.  
  63. TRANSLATION STRINGS
  64. ===================
  65.  
  66. DCSCBV converts the phone number entered by the user into a
  67. standardized form (1-AAA-BBB-CCCC) using the LOCAL_AREA token in
  68. the configuration file.  It then scans the file TRNSLATE.CFG and
  69. translates the standardized phone number into a number that can
  70. be dialed.  Here's how it works ...
  71.  
  72. Each line in TRNSLATE.CFG should contain two columns.  If the
  73. string contained in the first column is found in the standardized
  74. phone number, then that string is replaced with the string found
  75. in the second column of the file.  
  76.  
  77. For an example, let assume that the user enters "5551212" and
  78. your LOCAL_AREA token is "504".  The standardized form of this
  79. number will be "1-504-555-1212".  Now, lets assume that the
  80. following line can be found in TRNSLATE.CFG.
  81.  
  82. 1-504-555- 555-
  83.  
  84. The first column is compared to the standardized phone number and
  85. "1-504-555-" is replaced with "555-" resulting in "555-1212". 
  86. This is a dialable number and can now be compared for toll
  87. status, duplicate and unwanted numbers.
  88.  
  89.  
  90. TOLL STATUS
  91. ===========
  92.  
  93. To determine the toll status of a number, each line of TOLL.CFG
  94. is compared to the dialable number.  If the dialable number
  95. starts with a line that is read, then that number is considered
  96. to be a long distance call.
  97.  
  98. For example, if "1-" is contained in TOLL.CFG, and the dialable
  99. number is "555-1212", then the number would not be considered to
  100. be long distance.  If the dialable number read "1-504-555-1212"
  101. (which starts with "1-") then that number would be considered to
  102. be long distance.
  103.  
  104. This file could be used to compare numbers down to individual
  105. prefixes to consider them long distance.  For example, consider
  106. the following TOLL.CFG file.
  107.  
  108. 1-
  109. 486-
  110. 478-
  111.  
  112. If a number translated to "486-7890", then that number would be
  113. dialed and would be treated as a long distance call.
  114.  
  115.  
  116. DUPLICATE NUMBERS
  117. =================
  118.  
  119. When a user is verified, their dialable number is placed in the
  120. Data Phone field of the user database.  If the token CHECK_DUPES
  121. is uncommented in the configuration file, then DCSCBV will scan
  122. the user database to determine if another user has been verified
  123. using that number.  If another user has been verified using that
  124. number, then the DUPE.SCR file is displayed and the program exits
  125. back to the BBS.  The users access is not modified.
  126.  
  127.  
  128. UNWANTED NUMBERS
  129. ================
  130.  
  131. The process of checking unwanted numbers is identical to checking
  132. the toll status.  To determine if a number is unwanted, each line
  133. of UNWANTED.CFG is compared to the dialable number.  If the
  134. dialable number starts with a line that is read, then DCSCBV will
  135. display the DENY.SCR file and will exit back to the BBS.  The
  136. users access is not modified.
  137.  
  138. A sample UNWANTED.CFG would be:
  139. 1-900-     ; Toll calls
  140. 1-818-     ; Hawaii
  141. 454-6578   ; Your BBS or home number
  142.  
  143.  
  144. COMMAND LINE PARAMETERS
  145. =======================
  146.  
  147. DCSCBV will accept the following command line parameters.
  148.  
  149.                -P             Communication port (1 = COM1)
  150.                -B             Current baud rate
  151.                -S             Baud rate if port is locked
  152.                -N             Current task
  153.                -C             Specify configuration file
  154.  
  155.  
  156. CONFIGURATION FILE
  157. ==================
  158.  
  159. DCSCBV's configuration file is a standard ASCII text file that
  160. contains a list of tokens to customize the way DCSCBV will
  161. operate.  In this file, a semicolon (";") can be used as a
  162. comment.  All text after a semicolon and all blank lines will be
  163. ignored.
  164.  
  165. For tokens concerning modem commands, use the following list of
  166. translation characters.
  167.  
  168.                |              Transmits a Carriage Return (ASCII
  169.                               code 13)
  170.                ~              Creates a 1 second delay
  171.                `              Creates a 0.5 second delay
  172.                ^              Raises DTR on port
  173.                v              Lowers DTR on port
  174.  
  175. The following chart is a list of all recognized tokens along with
  176. their default values and a brief description.
  177.  
  178. NOTE: The only token that is required is LOCAL_AREA.
  179.  
  180. Token Name     Default        Description
  181. ----------------------------------------------------------------
  182. LOCAL_AREA                    The three digit number of your
  183.                               local area code.  This number will
  184.                               be used to create a standardized
  185.                               telephone number before translating
  186.                               to a dialable number.
  187.  
  188. CHECK_DUPES                   Will tell DCSCBV not to dial a
  189.                               number if another user has already
  190.                               been verified with it.  If this
  191.                               token is not present, DCSCBV will
  192.                               allow multiple users to be verified
  193.                               at the same number.
  194.  
  195. ADD_NONCONNECT                Will tell DCSCBV to add a number to
  196.                               the unwanted list if it failed to
  197.                               reconnect after the specified
  198.                               number of attempts.  If this token
  199.                               is not present, DCSCBV will allow a
  200.                               user to try again if it failed to
  201.                               reconnect.
  202.  
  203. LOGFILE        DCSCBV.LOG     Where sessions will be logged.  The
  204.                               file specified must contain the
  205.                               full path and filename.  The
  206.                               default extension .LOG will be
  207.                               added if one does not exist.  For
  208.                               tasks greater than zero, the last
  209.                               two characters of the filename
  210.                               (extension excluded) will be
  211.                               translated into the two digit
  212.                               hexadecimal value of the task
  213.                               number.
  214.  
  215. LOG_RESPONSE                  Will tell DCSCBV to add response
  216.                               messages from the modem to the log
  217.                               file after dialing.  If this token
  218.                               is not present, DCSCBV will not log
  219.                               modem responses.
  220.  
  221. MAX_DIR        \MAX\          Where DCSCBV can find the Maximus
  222.                               user database and LASTUS??.BBS.
  223.  
  224. USERFILE       USER.BBS       The name of the Maximus user
  225.                               database.  This file will be
  226.                               searched for in the directory
  227.                               specified by MAX_DIR.
  228.  
  229. PASS_PRIV      30             The privilege level to give a user
  230.                               after a successful verification.
  231.  
  232. PASS_XPFLAG    0              Expiry flags to set after a
  233.                               successful verification.
  234.  
  235. PASS_XPMINS    0              Expiry minutes to set after a
  236.                               successful verification.
  237.  
  238. PASS_XPDATE                   Expiry date to set after a
  239.                               successful verification.
  240.  
  241. PASS_XPPRIV    30             Expiry privilege to set after a
  242.                               successful verification.
  243.  
  244. VERIFY_TIME    60             The number of seconds to allow a
  245.                               user to enter their verification
  246.                               password.
  247.  
  248. PW_ATTEMPTS    3              The number of times to allow a user
  249.                               to enter their verification
  250.                               password.
  251.  
  252. LD_ATTEMPTS    1              The maximum number of times to dial
  253.                               a number to re-connect to a user if
  254.                               the toll status determines it to be
  255.                               outside of the local calling area.
  256.  
  257. LOCAL_ATTEMPTS 3              The maximum number of times to dial
  258.                               a number to re-connect to a user if
  259.                               the toll status determines it to be
  260.                               in the local calling area.
  261.  
  262. DIAL_DELAY     45             The maximum number of seconds to
  263.                               wait for a connect after dialing.
  264.  
  265. DIAL_PREFIX    ATDT           The string to send to the modem
  266.                               before the number to tell the modem
  267.                               to dial.
  268.  
  269. DIAL_SUFFIX    |              The string to send to the modem
  270.                               after the number to tell the modem
  271.                               to dial.
  272.  
  273. DIAL_HANGUP    v`^~+++~ATH0|  The string to send to the modem to
  274.                               hangup on the caller.
  275.  
  276. CBV_DIR        \MAX\DCSCBV\   Where DCSCBV can find all necessary
  277.                               files to run.  This includes all of
  278.                               the configuration and screen files
  279.                               which can be redefined here.
  280.  
  281. ================================================================
  282. NOTE: All of the files specified below should contain the
  283. filename and extension only.  They will be searched for in the
  284. directory specified by CBV_DIR.
  285. ================================================================
  286.  
  287. TRANSLATE      TRNSLATE.CFG   The name of the file that contains
  288.                               a list of translate strings to
  289.                               convert a standardized telephone
  290.                               number to a number that can be
  291.                               dialed from your system.
  292.  
  293. UNWANTED       UNWANTED.CFG   The name of the file that contains
  294.                               a list of numbers that you do not
  295.                               wish to be dialed.
  296.  
  297. TOLL           TOLL.CFG       The name of the file that contains
  298.                               a list of strings to compare a
  299.                               translated number to determine if
  300.                               it is in the local calling area.
  301.  
  302. ALREADY        ALREADY.SCR    The name of the file to display to
  303.                               the user if he/she already has a
  304.                               privilege level greater than or
  305.                               equal to PASS_PRIV.
  306.  
  307. INTRO          INTRO.SCR      The name of the file to display to
  308.                               the user just before prompting for
  309.                               their phone number.
  310.  
  311. DUPE           DUPE.SCR       The name of the file to display to
  312.                               the user if the number he/she
  313.                               entered was used to verify another
  314.                               user.
  315.  
  316. DENY           DENY.SCR       The name of the file to display to
  317.                               the user if the number he/she
  318.                               entered was found in the unwanted
  319.                               numbers file.
  320.  
  321. PASSCODE       PASSCODE.SCR   The name of the file to display to
  322.                               the user just before giving them a
  323.                               verification password.
  324.  
  325. READY          READY.SCR      The name of the file to display to
  326.                               the user just before hanging up and
  327.                               just before displaying the LOCAL or
  328.                               LD file.
  329.  
  330. LOCAL          LOCAL.SCR      The name of the file to display to
  331.                               the user if the toll status
  332.                               determines the caller to be in the
  333.                               local calling area.  DCSCBV will
  334.                               display this file just before
  335.                               hanging up and just after
  336.                               displaying the READY file.
  337.  
  338. LD             LD.SCR         The name of the file to display to
  339.                               the user if the toll status
  340.                               determines the caller to be outside
  341.                               of the local calling area.  DCSCBV
  342.                               will display this file just before
  343.                               hanging up and just after
  344.                               displaying the READY file.
  345.  
  346. PASS           PASS.SCR       The name of the file to display to
  347.                               the user after a successful
  348.                               verification.
  349.  
  350. FAIL           FAIL.SCR       The name of the file to display to
  351.                               the user after entering the wrong
  352.                               verification password with the
  353.                               specified number PW_ATTEMPTS.
  354.  
  355.  
  356. REGISTRATION
  357. ============
  358.  
  359. DCSCBV is distributed as ShareWare.  You are entitled to 30 days
  360. to evalueate this software.  To register DCSCBV, fill out the
  361. form and send $10 to the address below.  All registered users of
  362. this software will be notified of future releases and will
  363. receive a discount on all upgrades.  There will be no cost for
  364. minor changes and bug fixes.  This beta release is distributed
  365. without any restrictions or limitations.
  366.  
  367. COMPANY:       _____________________________________________
  368. NAME:          _____________________________________________
  369. ADDDRESS:      _____________________________________________
  370.                _____________________________________________
  371. CITY/ST/ZIP:   _____________________________________________
  372.  
  373. BBS NAME:      _____________________________________________
  374. # OF LINES:    _____________________________________________
  375. PRIMARY PHONE: _____________________________________________
  376. MODEM TYPE:    _____________________________________________
  377. FIDO ADDRESS:  _____________________________________________
  378.  
  379. WHERE DID YOU HEAR ABOUT THIS SOFTWARE? ____________________
  380. ____________________________________________________________
  381.  
  382. Send $10 check or money order along with this registration form
  383. to:
  384.  
  385. Data Communication Systems
  386. 2221 Houma Blvd, Apt 102
  387. Metairie, LA  70001
  388.  
  389.  
  390. DISCLAIMER
  391. ==========
  392.  
  393. Neither Data Communication Systems nor any of its authors,
  394. programmers, employees or owners will be held liable for any
  395. special, direct, indirect, incidental, consequential, exemplary
  396. or punitive damages or any inconvenience arising out of the
  397. provision or use of this software.
  398.  
  399. The latest version of this software may be obtained from the
  400. following BBS:
  401.  
  402. The Third Millennium
  403. Located in Metairie, Louisiana
  404. Operating 24 hours a day, 7 days a week
  405. A service of Data Communication Systems
  406.  
  407.   1:396/85  @ FidoNet
  408.   8:3007/2  @ FamilyNet
  409.   24:101/3  @ CCHN (Christian Concert Hotline Network)
  410.   97:2001/1 @ SubSpaceNet
  411.  
  412. (504) 454-6578 : 300 - 28,800 b.p.s. (V.34)
  413.  
  414. FTSC file requests can be made using the name "CBV".  In the
  415. future case of relocation, questions or suggestions, the authors
  416. of this software can be reached through the FidoNet MUFFIN, MECCA
  417. or PASCAL echo.  If your message does not adhere to the rules or
  418. topic of the echo's then please address them via NetMail or in a
  419. locally through the BBS.  To guarantee reception of the message,
  420. please address it to "David Dunson". 
  421.  
  422.